/*
 * Copyright 2017 ~ 2025 the original author or authors. James Wong <jameswong1376@gmail.com>>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.wl4g.infra.common.remoting;

import java.io.IOException;
import java.io.OutputStream;

import com.wl4g.infra.common.remoting.parse.HttpOutputMessage;

/**
 * Represents an HT TP output message that allows for setting a streaming body.
 * Note that such messages typically do not support {@link #getBody()} access.
 *
 * @see #setBody
 */
public interface StreamingHttpOutputMessage extends HttpOutputMessage {

    /**
     * Set the streaming body callback for this message.
     * 
     * @param body
     *            the streaming body callback
     */
    void setBody(Body body);

    /**
     * Defines the contract for bodies that can be written directly to an
     * {@link OutputStream}. Useful with HTTP client libraries that provide
     * indirect access to an {@link OutputStream} via a callback mechanism.
     */
    @FunctionalInterface
    interface Body {

        /**
         * Write this body to the given {@link OutputStream}.
         * 
         * @param outputStream
         *            the output stream to write to
         * @throws IOException
         *             in case of I/O errors
         */
        void writeTo(OutputStream outputStream) throws IOException;
    }

}